Java 工具类之获取客户端 IP

如果你的应用部署在 Nginx 后面，你必须确保 Nginx 配置了头部转发，否则 IpUtils 拿到的永远是 Nginx 所在的内网 IP。

1
2
3
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;


核心代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
import jakarta.servlet.http.HttpServletRequest;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.StringUtils;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import java.net.InetAddress;
import java.net.UnknownHostException;

/**
 * IP 工具类
 *
 * @author KJ
 * @description 支持解析多层代理 (Nginx, CDN, SLB) 下的真实客户端 IP
 */

@Slf4j
public class IpUtils {

    private static final String UNKNOWN = "unknown";
    private static final String LOCALHOST_IPV4 = "127.0.0.1";
    private static final String LOCALHOST_IPV6 = "0:0:0:0:0:0:0:1";

    /**
     * 在全局 AOP 或 Controller 中直接获取当前请求的真实 IP
     */
    public static String getIp() {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        if (attributes == null) {
            return LOCALHOST_IPV4;
        }
        return getIp(attributes.getRequest());
    }

    /**
     * 获取真实 IP 地址
     */
    public static String getIp(HttpServletRequest request) {
        if (request == null) {
            return UNKNOWN;
        }

        // 核心原理：按优先级从各个 Header 中提取
        // 1. X-Forwarded-For: 最常用的代理协议，格式为 Client, Proxy1, Proxy2...
        String ip = request.getHeader("x-forwarded-for");

        // 2. Proxy-Client-IP: Apache HTTP Server 代理
        if (isInvalid(ip)) {
            ip = request.getHeader("Proxy-Client-IP");
        }

        // 3. WL-Proxy-Client-IP: WebLogic 代理
        if (isInvalid(ip)) {
            ip = request.getHeader("WL-Proxy-Client-IP");
        }

        // 4. HTTP_CLIENT_IP: 部分代理
        if (isInvalid(ip)) {
            ip = request.getHeader("HTTP_CLIENT_IP");
        }

        // 5. X-Real-IP: Nginx 常用配置，只记录最后一个代理传过来的真实 IP
        if (isInvalid(ip)) {
            ip = request.getHeader("X-Real-IP");
        }

        // 6. 最终方案：直接获取连接地址
        if (isInvalid(ip)) {
            ip = request.getRemoteAddr();
            // 如果是本机访问，根据网卡取本机配置的 IP
            if (LOCALHOST_IPV4.equals(ip) || LOCALHOST_IPV6.equals(ip)) {
                try {
                    InetAddress confIp = InetAddress.getLocalHost();
                    ip = confIp.getHostAddress();
                } catch (UnknownHostException e) {
                    log.error("IpUtils error: ", e);
                }
            }
        }

        // 7. 处理多层代理的情况
        // X-Forwarded-For 的值如果是 "192.168.1.1, 10.0.0.1"，第一个才是真实客户端 IP
        if (StringUtils.hasText(ip) && ip.contains(",")) {
            ip = ip.split(",")[0].trim();
        }

        return ip;
    }

    private static boolean isInvalid(String ip) {
        return !StringUtils.hasText(ip) || UNKNOWN.equalsIgnoreCase(ip);
    }
}


标题：
Java 工具类之获取客户端 IP
作者：
kinglyjn
声明：
引用 本文 请务必注明出处，原创不易，感谢尊重。